From: Eli Zaretskii Date: Fri, 22 Mar 2024 07:54:37 +0000 (+0200) Subject: ; * lisp/help-fns.el (help-fns-function-name): Doc fix. X-Git-Tag: archive/raspbian/1%30.1+1-3+rpi1^2~14^2~18^2~2176 X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=c1530a2e4973005633ebe00d447f1f3aa1200301;p=emacs.git ; * lisp/help-fns.el (help-fns-function-name): Doc fix. --- diff --git a/lisp/help-fns.el b/lisp/help-fns.el index 422f6e9dddf..638af81ded8 100644 --- a/lisp/help-fns.el +++ b/lisp/help-fns.el @@ -2465,7 +2465,14 @@ one of them returns non-nil." ;;;###autoload (defun help-fns-function-name (function) - "Return a short string representing FUNCTION." + "Return a short buttonized string representing FUNCTION. +The string is propertized with a button; clicking on that +provides further details about FUNCTION. +FUNCTION can be a function, a built-in, a keyboard macro, +or a compile function. +This function is intended to be used to display various +callable symbols in buffers in a way that allows the user +to find out more details about the symbols." ;; FIXME: For kmacros, should we print the key-sequence? (cond ((symbolp function)